home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / sgesvx.z / sgesvx
Text File  |  1996-03-14  |  13KB  |  331 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGESVX - use the LU factorization to compute the solution to a real
  10.      system of linear equations  A * X = B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGESVX( FACT, TRANS, N, NRHS, A, LDA, AF, LDAF, IPIV, EQUED,
  14.                         R, C, B, LDB, X, LDX, RCOND, FERR, BERR, WORK, IWORK,
  15.                         INFO )
  16.  
  17.          CHARACTER      EQUED, FACT, TRANS
  18.  
  19.          INTEGER        INFO, LDA, LDAF, LDB, LDX, N, NRHS
  20.  
  21.          REAL           RCOND
  22.  
  23.          INTEGER        IPIV( * ), IWORK( * )
  24.  
  25.          REAL           A( LDA, * ), AF( LDAF, * ), B( LDB, * ), BERR( * ), C(
  26.                         * ), FERR( * ), R( * ), WORK( * ), X( LDX, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      SGESVX uses the LU factorization to compute the solution to a real system
  30.      of linear equations
  31.         A * X = B, where A is an N-by-N matrix and X and B are N-by-NRHS
  32.      matrices.
  33.  
  34.      Error bounds on the solution and a condition estimate are also provided.
  35.  
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      The following steps are performed:
  39.  
  40.      1. If FACT = 'E', real scaling factors are computed to equilibrate
  41.         the system:
  42.            TRANS = 'N':  diag(R)*A*diag(C)     *inv(diag(C))*X = diag(R)*B
  43.            TRANS = 'T': (diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
  44.            TRANS = 'C': (diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
  45.         Whether or not the system will be equilibrated depends on the
  46.         scaling of the matrix A, but if equilibration is used, A is
  47.         overwritten by diag(R)*A*diag(C) and B by diag(R)*B (if TRANS='N')
  48.         or diag(C)*B (if TRANS = 'T' or 'C').
  49.  
  50.      2. If FACT = 'N' or 'E', the LU decomposition is used to factor the
  51.         matrix A (after equilibration if FACT = 'E') as
  52.            A = P * L * U,
  53.         where P is a permutation matrix, L is a unit lower triangular
  54.         matrix, and U is upper triangular.
  55.  
  56.      3. The factored form of A is used to estimate the condition number
  57.         of the matrix A.  If the reciprocal of the condition number is
  58.         less than machine precision, steps 4-6 are skipped.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      4. The system of equations is solved for X using the factored form
  75.         of A.
  76.  
  77.      5. Iterative refinement is applied to improve the computed solution
  78.         matrix and calculate error bounds and backward error estimates
  79.         for it.
  80.  
  81.      6. If equilibration was used, the matrix X is premultiplied by
  82.         diag(C) (if TRANS = 'N') or diag(R) (if TRANS = 'T' or 'C') so
  83.         that it solves the original system before equilibration.
  84.  
  85.  
  86. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  87.      FACT    (input) CHARACTER*1
  88.              Specifies whether or not the factored form of the matrix A is
  89.              supplied on entry, and if not, whether the matrix A should be
  90.              equilibrated before it is factored.  = 'F':  On entry, AF and
  91.              IPIV contain the factored form of A.  If EQUED is not 'N', the
  92.              matrix A has been equilibrated with scaling factors given by R
  93.              and C.  A, AF, and IPIV are not modified.  = 'N':  The matrix A
  94.              will be copied to AF and factored.
  95.              = 'E':  The matrix A will be equilibrated if necessary, then
  96.              copied to AF and factored.
  97.  
  98.      TRANS   (input) CHARACTER*1
  99.              Specifies the form of the system of equations:
  100.              = 'N':  A * X = B     (No transpose)
  101.              = 'T':  A**T * X = B  (Transpose)
  102.              = 'C':  A**H * X = B  (Transpose)
  103.  
  104.      N       (input) INTEGER
  105.              The number of linear equations, i.e., the order of the matrix A.
  106.              N >= 0.
  107.  
  108.      NRHS    (input) INTEGER
  109.              The number of right hand sides, i.e., the number of columns of
  110.              the matrices B and X.  NRHS >= 0.
  111.  
  112.      A       (input/output) REAL array, dimension (LDA,N)
  113.              On entry, the N-by-N matrix A.  If FACT = 'F' and EQUED is not
  114.              'N', then A must have been equilibrated by the scaling factors in
  115.              R and/or C.  A is not modified if FACT = 'F' or
  116.  
  117.              On exit, if EQUED .ne. 'N', A is scaled as follows:  EQUED = 'R':
  118.              A := diag(R) * A
  119.              EQUED = 'C':  A := A * diag(C)
  120.              EQUED = 'B':  A := diag(R) * A * diag(C).
  121.  
  122.      LDA     (input) INTEGER
  123.              The leading dimension of the array A.  LDA >= max(1,N).
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      AF      (input or output) REAL array, dimension (LDAF,N)
  141.              If FACT = 'F', then AF is an input argument and on entry contains
  142.              the factors L and U from the factorization A = P*L*U as computed
  143.              by SGETRF.  If EQUED .ne. 'N', then AF is the factored form of
  144.              the equilibrated matrix A.
  145.  
  146.              If FACT = 'N', then AF is an output argument and on exit returns
  147.              the factors L and U from the factorization A = P*L*U of the
  148.              original matrix A.
  149.  
  150.              If FACT = 'E', then AF is an output argument and on exit returns
  151.              the factors L and U from the factorization A = P*L*U of the
  152.              equilibrated matrix A (see the description of A for the form of
  153.              the equilibrated matrix).
  154.  
  155.      LDAF    (input) INTEGER
  156.              The leading dimension of the array AF.  LDAF >= max(1,N).
  157.  
  158.      IPIV    (input or output) INTEGER array, dimension (N)
  159.              If FACT = 'F', then IPIV is an input argument and on entry
  160.              contains the pivot indices from the factorization A = P*L*U as
  161.              computed by SGETRF; row i of the matrix was interchanged with row
  162.              IPIV(i).
  163.  
  164.              If FACT = 'N', then IPIV is an output argument and on exit
  165.              contains the pivot indices from the factorization A = P*L*U of
  166.              the original matrix A.
  167.  
  168.              If FACT = 'E', then IPIV is an output argument and on exit
  169.              contains the pivot indices from the factorization A = P*L*U of
  170.              the equilibrated matrix A.
  171.  
  172.      EQUED   (input or output) CHARACTER*1
  173.              Specifies the form of equilibration that was done.  = 'N':  No
  174.              equilibration (always true if FACT = 'N').
  175.              = 'R':  Row equilibration, i.e., A has been premultiplied by
  176.              diag(R).  = 'C':  Column equilibration, i.e., A has been
  177.              postmultiplied by diag(C).  = 'B':  Both row and column
  178.              equilibration, i.e., A has been replaced by diag(R) * A *
  179.              diag(C).  EQUED is an input argument if FACT = 'F'; otherwise, it
  180.              is an output argument.
  181.  
  182.      R       (input or output) REAL array, dimension (N)
  183.              The row scale factors for A.  If EQUED = 'R' or 'B', A is
  184.              multiplied on the left by diag(R); if EQUED = 'N' or 'C', R is
  185.              not accessed.  R is an input argument if FACT = 'F'; otherwise, R
  186.              is an output argument.  If FACT = 'F' and EQUED = 'R' or 'B',
  187.              each element of R must be positive.
  188.  
  189.      C       (input or output) REAL array, dimension (N)
  190.              The column scale factors for A.  If EQUED = 'C' or 'B', A is
  191.              multiplied on the right by diag(C); if EQUED = 'N' or 'R', C is
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206.              not accessed.  C is an input argument if FACT = 'F'; otherwise, C
  207.              is an output argument.  If FACT = 'F' and EQUED = 'C' or 'B',
  208.              each element of C must be positive.
  209.  
  210.      B       (input/output) REAL array, dimension (LDB,NRHS)
  211.              On entry, the N-by-NRHS right hand side matrix B.  On exit, if
  212.              EQUED = 'N', B is not modified; if TRANS = 'N' and EQUED = 'R' or
  213.              'B', B is overwritten by diag(R)*B; if TRANS = 'T' or 'C' and
  214.              EQUED = 'C' or 'B', B is overwritten by diag(C)*B.
  215.  
  216.      LDB     (input) INTEGER
  217.              The leading dimension of the array B.  LDB >= max(1,N).
  218.  
  219.      X       (output) REAL array, dimension (LDX,NRHS)
  220.              If INFO = 0, the N-by-NRHS solution matrix X to the original
  221.              system of equations.  Note that A and B are modified on exit if
  222.              EQUED .ne. 'N', and the solution to the equilibrated system is
  223.              inv(diag(C))*X if TRANS = 'N' and EQUED = 'C' or or 'B'.
  224.  
  225.      LDX     (input) INTEGER
  226.              The leading dimension of the array X.  LDX >= max(1,N).
  227.  
  228.      RCOND   (output) REAL
  229.              The estimate of the reciprocal condition number of the matrix A
  230.              after equilibration (if done).  If RCOND is less than the machine
  231.              precision (in particular, if RCOND = 0), the matrix is singular
  232.              to working precision.  This condition is indicated by a return
  233.              code of INFO > 0, and the solution and error bounds are not
  234.              computed.
  235.  
  236.      FERR    (output) REAL array, dimension (NRHS)
  237.              The estimated forward error bound for each solution vector X(j)
  238.              (the j-th column of the solution matrix X).  If XTRUE is the true
  239.              solution corresponding to X(j), FERR(j) is an estimated upper
  240.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  241.              divided by the magnitude of the largest element in X(j).  The
  242.              estimate is as reliable as the estimate for RCOND, and is almost
  243.              always a slight overestimate of the true error.
  244.  
  245.      BERR    (output) REAL array, dimension (NRHS)
  246.              The componentwise relative backward error of each solution vector
  247.              X(j) (i.e., the smallest relative change in any element of A or B
  248.              that makes X(j) an exact solution).
  249.  
  250.      WORK    (workspace/output) REAL array, dimension (4*N)
  251.              On exit, WORK(1) contains the reciprocal pivot growth factor
  252.              norm(A)/norm(U). The "max absolute element" norm is used. If
  253.              WORK(1) is much less than 1, then the stability of the LU
  254.              factorization of the (equilibrated) matrix A could be poor. This
  255.              also means that the solution X, condition estimator RCOND, and
  256.              forward error bound FERR could be unreliable. If factorization
  257.              fails with 0<INFO<=N, then WORK(1) contains the reciprocal pivot
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  269.  
  270.  
  271.  
  272.              growth factor for the leading INFO columns of A.
  273.  
  274.      IWORK   (workspace) INTEGER array, dimension (N)
  275.  
  276.      INFO    (output) INTEGER
  277.              = 0:  successful exit
  278.              < 0:  if INFO = -i, the i-th argument had an illegal value
  279.              > 0:  if INFO = i, and i is
  280.              <= N:  U(i,i) is exactly zero.  The factorization has been
  281.              completed, but the factor U is exactly singular, so the solution
  282.              and error bounds could not be computed.  = N+1: RCOND is less
  283.              than machine precision.  The factorization has been completed,
  284.              but the matrix is singular to working precision, and the solution
  285.              and error bounds have not been computed.
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.